/*
 * Copyright:  2018 smarabbit studio.
 *
 *  Licensed under the Confluent Community License; you may not use this file
 *  except in compliance with the License.  You may obtain a copy of the License at
 *
 *  http://www.confluent.io/confluent-community-license
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OF ANY KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations under the License.
 *
 *  @作   者： 黄开晖 (117227773@qq.com)
 *  @日   期:  2021年5月28日
 */
package com.massyframework.beanskin.assembly;

import java.util.List;

import com.massyframework.beanskin.InitParamsConfig;
import com.massyframework.beanskin.service.DependencyServiceDescriptor;
import com.massyframework.beanskin.service.ExportServiceDescriptor;
import com.massyframework.beanskin.util.version.VersionRange;

/**
 * 装配件配置项目
 * 
 * <p>
 * 在{@link InitParamsConfig}的基础上，增加bean容器的定义。
 * @author huangkh
 *
 */
public interface AssemblyConfig extends InitParamsConfig {
	
	/* 内嵌的jar文件 */
	static final String LIB_JARS      = "assembly.lib.jars";
		
	/**
	 * bean容器名称
	 * @return {@link String}
	 */
	String getBeanContextName();
	
	/**
	 * 基于配置文件策略: 配置文件
	 * @return {@link String}数组，可能为null.
	 */
	String[] getConfigLocations();
	
	/**
	 * 基于注解配置策略: 注解配置类
	 * @return {@link String}数组，可能返回null.
	 */
	Class<?>[] getConfigTypes();
	
	/**
	 * 所有依赖的服务
	 * 
	 * @return {@link List}, 依赖服务描述列表
	 */
	List<DependencyServiceDescriptor<?>> getDependencyServiceDescriptors();
	
	/**
     * 所有输出的服务
     * @return {@link List}, 输出服务描述列表
     */
    List<ExportServiceDescriptor> getExportServiceDescriptors();
    
    /**
     * 是否支持Servlet组件
     * @return {@link boolean},支持返回{@code true},否则返回{@code false}
     */
    default boolean supportServlet() {
    	return this.getServletModel() == ServletModel.NONE;
    }
    
    /**
     * Servlet模型
     * <p>
     * 用来标注在初始化期间是否支持注册Listener、Servlet、Filter等Web组件。
     * @return {@link ServletModel}
     */
    ServletModel getServletModel();
    
	/**
	 * bean容器的版本范围
	 * @return {@link VersionRange}
	 */
	VersionRange getVersionRangeWithBeanContext();
}
